Skip to main content
Version: 5.1.1.0

Health Check Metrics Endpoint

Concept​

The Orchestra External Monitoring API enables monitoring of Java Virtual Machine (JVM) Metrics through an HTTP endpoint. It also presents runtime metrics of the Orchestra processes.

To access all features, a separate license for the Orchestra External Monitoring API must be obtained. Without a license, only up to 10 values can be displayed. All other values will show "NaN".

Settings​

Settings for the Metrics Endpoint can be accessed in Orchestra Monitor under Settings > Environment settings > Runtime Metrics of orchestra (group).

JVM metrics are always up-to-date. You can define the update interval for the process metrics under refresh.time (in seconds).

Authentication can also be modified, with options for NONE or PASSWORD.

metrics environment settings

Endpoint​

After authenticating in Orchestra monitoring, runtime metrics can be viewed at the following URL:

http://[hostname]:[http-port]/Orchestra/default/RuntimeHealthMetrics

The endpoint displays the following JVM Metrics:

  1. Jvm Memory Metrics

  2. Jvm Thread Metrics

  3. Jvm Compilation Metrics

  4. Jvm Garbage Collection Metrics

  5. Jvm Heap Pressure Metrics

Processes are summarized under the following categories: running, finished, aborted, waiting, and paused processes.

In this summary, the number of processes is categorized by scenario ID.

running processes